Package-level declarations
Types
Link copied to clipboard
data class DocumentDataExtractionProgressConfiguration(var enabled: Boolean = true, var progressColor: ScanbotColor = ScanbotColor("#40A9FF", isArgb = false), var animationDuration: Int = 1000) : Parcelable
Configuration of visualization of the scanning progress - indeterminate progress.
Link copied to clipboard
data class DocumentDataExtractorGuidanceConfiguration(var visibility: Boolean = true, var title: StyledText = StyledText( text = "?documentUserGuidanceNoDocumentFound", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) ), var statesTitles: DocumentDataExtractorGuidanceStates = DocumentDataExtractorGuidanceStates( )) : Parcelable
Configuration of the hints guiding users through the document scanning process.
Link copied to clipboard
data class DocumentDataExtractorGuidanceStates(var noDocumentFound: String = "?documentUserGuidanceNoDocumentFound", var scanningProgress: String = "?documentUserGuidanceScanningProgress", var tooDark: String = "?documentUserGuidanceTooDark", var tooSmall: String = "?documentUserGuidanceTooSmall", var badPerspective: String = "?documentUserGuidanceBadPerspective") : Parcelable
Configure the captions of the user guidance hints for different scanning states.
Link copied to clipboard
The image for the introduction screen of a document data extractor screen.
Link copied to clipboard
data class DocumentDataExtractorIntroScreenConfiguration(var image: DocumentDataExtractorIntroImage = DocumentDataIntroDefaultImage( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var handlerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var showAutomatically: Boolean = false, var title: StyledText = StyledText( text = "?introScreenTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var explanation: StyledText = StyledText( text = "?introScreenText", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var doneButton: ButtonConfiguration = ButtonConfiguration( text = "?introScreenDoneButton", accessibilityDescription = "?accessibilityDescriptionIntroScreenDoneButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) )) : Parcelable
Configuration of the introduction screen for the document data extractor.
Link copied to clipboard
Android native configuration for the scanner.
Link copied to clipboard
data class DocumentDataExtractorScreenConfiguration(val version: String = "1.0", val screen: String = "DocumentDataExtractor", var localization: DocumentDataExtractorScreenTextLocalization = DocumentDataExtractorScreenTextLocalization( ), var palette: Palette = Palette( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), var cameraConfiguration: CameraConfiguration = CameraConfiguration( orientationLockMode = OrientationLockMode.PORTRAIT ), var cameraPermission: CameraPermissionScreen = CameraPermissionScreen( statusBarMode = StatusBarMode.DARK, background = ScanbotColor("?sbColorSurface", isArgb = false), iconBackground = ScanbotColor("?sbColorOutline", isArgb = false), icon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraButton = ButtonConfiguration( visible = true, text = "?cameraPermissionEnableCameraButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), closeButton = ButtonConfiguration( visible = true, text = "?cameraPermissionCloseButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), enableCameraTitle = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraExplanation = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ) ), var topUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?topUserGuidance" ) ), var scanStatusUserGuidance: DocumentDataExtractorGuidanceConfiguration = DocumentDataExtractorGuidanceConfiguration( ), var topBar: TopBarConfiguration = TopBarConfiguration( title = StyledText( visible = true, text = "?topBarTitle" ), cancelButton = ButtonConfiguration( text = "?topBarCancelButton", accessibilityDescription = "?accessibilityDescriptionCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ) ), var topBarOpenIntroScreenButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionOpenIntroScreenButton" ), var introScreen: DocumentDataExtractorIntroScreenConfiguration = DocumentDataExtractorIntroScreenConfiguration( ), var actionBar: ActionBarConfiguration = ActionBarConfiguration( flipCameraButton = RoundButton( visible = false, accessibilityDescription = "?accessibilityDescriptionFlipCameraButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) ) ), var viewFinder: PermanentViewFinderConfiguration = PermanentViewFinderConfiguration( style = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0 ), aspectRatio = AspectRatio( width = 3.0, height = 2.0 ), minimumInsets = EdgeInsets( top = 24.0, left = 24.0, bottom = 24.0, right = 24.0 ) ), var scannerConfiguration: DocumentDataExtractorConfiguration = DocumentDataExtractorConfiguration( ), var extractionProgress: DocumentDataExtractionProgressConfiguration = DocumentDataExtractionProgressConfiguration( ), var noDocumentFoundTimeout: Int = 5000, var accumulationTimeout: Int = 3000, var successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), var noDocumentDetectedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorNoDocumentDetectedAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorNoDocumentDetectedAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), var cantProcessDocumentAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorCantProcessDocumentAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorCantProcessDocumentAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), var unsupportedDocumentAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorUnsupportedDocumentAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorUnsupportedDocumentAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), var scanningTooLongAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorScanningTooLongAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorScanningTooLongAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), var sound: Sound = Sound( ), var vibration: Vibration = Vibration( ), var keepScreenOn: Boolean = true) : Parcelable
Configuration of the screen for extracting data from ID documents.
Link copied to clipboard
data class DocumentDataExtractorScreenTextLocalization(var topBarTitle: String = "Document Data Extractor", var topBarCancelButton: String = "Cancel", var topUserGuidance: String = "Point the camera at the ID document", var introScreenTitle: String = "How to scan an ID document", var introScreenDoneButton: String = "Start Scanning", var introScreenText: String = "To scan an ID, position the document within the frame, ensuring it's properly aligned and all key details are clearly visible. The scanner will then automatically extract essential information like name, date of birth, and document number. Once scanned, the data will be processed.", var completionOverlaySuccessMessage: String = "Scanned successfully", var accessibilityDescriptionOpenIntroScreenButton: String = "Open ID document scanning introduction", var accessibilityDescriptionIntroScreenDoneButton: String = "Start ID scanning", var accessibilityDescriptionCancelButton: String = "Cancel ID scanning", var accessibilityDescriptionRetryButton: String = "Retry ID scanning", var accessibilityDescriptionCloseScannerButton: String = "Close the scanner", var documentDataExtractorAlertRetryButton: String = "Retry", var documentDataExtractorAlertCloseScannerButton: String = "Close Scanner", var documentDataExtractorNoDocumentDetectedAlertTitle: String = "No document detected", var documentDataExtractorNoDocumentDetectedAlertSubtitle: String = "The scanner couldn't detect the document. Please ensure it's well-lit and fully visible, then try again.", var documentDataExtractorCantProcessDocumentAlertTitle: String = "Document could not be processed", var documentDataExtractorCantProcessDocumentAlertSubtitle: String = "This document doesn't meet the processing requirements. Please check accepted document types and try again.", var documentDataExtractorUnsupportedDocumentAlertTitle: String = "Unsupported document", var documentDataExtractorUnsupportedDocumentAlertSubtitle: String = "This document type isn't supported. Please try again with a valid document format.", var documentDataExtractorScanningTooLongAlertTitle: String = "Scanning took too long", var documentDataExtractorScanningTooLongAlertSubtitle: String = "Scanning took longer than expected. Please ensure the document is well-lit and fully visible, then try again.", var accessibilityDescriptionFlashButton: String = "Toggle flash", var accessibilityDescriptionZoomButton: String = "Toggle camera zoom", var accessibilityDescriptionFlipCameraButton: String = "Flip camera", var cameraPermissionEnableCameraTitle: String = "Camera permission denied!", var cameraPermissionEnableCameraExplanation: String = "Please allow the usage of the camera to start the scanning process.", var cameraPermissionEnableCameraButton: String = "Grant permission", var cameraPermissionCloseButton: String = "Close", var accessibilityDescriptionCameraPermissionEnableCameraButton: String = "Tap to grant camera permission", var accessibilityDescriptionCameraPermissionCloseButton: String = "Close screen without granting permission", var documentUserGuidanceNoDocumentFound: String = "Looking for document...", var documentUserGuidanceScanningProgress: String = "Scanning the document...", var documentUserGuidanceTooDark: String = "Too dark. Please turn on a light.", var documentUserGuidanceTooSmall: String = "Please move closer to the document.", var documentUserGuidanceBadPerspective: String = "Please hold your device straight over the document.") : Parcelable
Configuration of the all strings for document data extractor screen.
Link copied to clipboard
data class DocumentDataExtractorUiResult(val recognitionStatus: DocumentDataExtractionStatus, val document: GenericDocument?, val croppedImage: ImageRef?) : AutoCloseable, Parcelable
Configuration of the generic text scanner RTU UI result.
Link copied to clipboard
data class DocumentDataIntroCustomImage(var uri: String) : DocumentDataExtractorIntroImage, Parcelable
A custom image for the introduction screen.
Link copied to clipboard
The image for the introduction screen featuring a document.
Link copied to clipboard
No image for the introduction screen.